zz-Dev Création de l’interface utilisateur générant le projet de publication

Vignette rédigée à l’intention des mainteneurs du package {propre.rpls}.

Fichier skeleton.dcf

Après avoir installé le package {propre.rpls}, l’utilisateur crée son projet RStudio de publication en sélectionnant :
New projet > New directory > Projet type : Publication RPLS Une interface de sélection des paramètres s’ouvre alors :

L’utilisateur y définit son choix de répertoire de travail (path), le millésime des données RPLS pour lesquels il souhaite réaliser une publication, la région observée et le type d’analyses par EPCI.

Cette interface est définie par le fichier propre.rpls/inst/rstudio/templates/project/skeleton.dcf. Ces choix de paramètres sont utilisés par les fonctions du fichier R/skeleton.R, élaboré grâce à la documentation de Rstudio sur les projet de template.

library(propre.rpls)
#> Error in get(paste0(generic, ".", class), envir = get_method_env()) : 
#>   object 'type_sum.accel' not found

Fonction propre.rpls_skeleton()

Fonction de création du répertoire du projet de l’utilisateur : à partir de la saisie des paramètres par l’utilisateur dans l’interface RStudio, cette fonction peuple le répertoire de travail de l’utilisateur avec le bookdown paramétré et fixe les paramètres dans l’entête du fichier index.Rmd Elle renvoie TRUE. Exemple :

propre.rpls_skeleton("rpls2023bretagne",
  annee = "2023", epci_ref = "1- Tous les EPCI de la zone",
  nom_region = "Bretagne"
)

Cette fonction va créer un projet RStudio pour la publication RPLS 2023 de la Bretagne, paramétrée pour détailler les tableaux et graphiques avec les données de tous les EPCI de la région, dans un répertoire intitulé “rpls2023bretagne”.

Fonction propre.rpls_file()

Cette fonction renvoie les adresses absolues des fichiers présents dans le répertoire d’installation du package à partir de leur adresse relative. Exemple :

propre.rpls_file("rstudio", "templates", "project", "ressources")
#> [1] "/tmp/Rtmpvt9Vzt/temp_libpathe566bf87c/propre.rpls/rstudio/templates/project/ressources"

Elle est mobilisée par la fonction skeleton pour rapatrier le template de publication dans le projet de l’utilisateur.